home *** CD-ROM | disk | FTP | other *** search
/ MaxiMac 2000 January / MaxiMac 98.iso / Macworld on CD N°98 / Extrême Mobile / Pilot / -> Palm / SmartDoc 2.0 / smartdoc.txt < prev   
Encoding:
Text File  |  1999-11-14  |  21.4 KB  |  524 lines  |  [TEXT/MSWD]

  1. ===============
  2. SmartDoc Manual
  3. ===============
  4.  
  5. READ, CREATE, DISTRIBUTE
  6.  
  7. SmartDoc is a powerful application that allows you to read, create, edit, and distribute text documents using the industry standard Doc format.
  8.  
  9. EASY
  10.  
  11. SmartDoc is easy to use. If you're already using the built-in applications, you can begin reading and writing right away.
  12.  
  13. ADVANCED
  14.  
  15. SmartDoc also has many advanced features: Find and replace text. Rename and reorder bookmarks. Beam and download documents.
  16.  
  17.  
  18. ==============
  19. USING SMARTDOC
  20. ==============
  21.  
  22. SmartDoc has two basic views: the List view and the Document view.
  23.  
  24. The List view displays a list of the documents that are present on your device. At a minimum, the title of the document is shown. Optionally, settings icons, the document date, or the document size may be shown by altering the Preferences. Tapping on the document title will open the document.
  25.  
  26. The Document view displays the current chosen document. You may read, edit, or perform other actions here.
  27.  
  28. -----------
  29. COMPRESSION
  30. -----------
  31.  
  32. The Doc format handles compressed and uncompressed text. The compression algorithm reduces memory use by 30-40% with average English language text.
  33.  
  34. The compression format is asymmetric. Decompression is much faster than compression. Decompression, which is used every time you view compressed text, is nearly instantaneous.
  35.  
  36. However, compression requires intense processing, and because of the more limited processing capabilities of your device, compression may take an extraordinary amount of time.
  37.  
  38. On current devices, the average time is about 6 seconds per kilobyte of uncompressed text, or about 12 kilobytes per minute.
  39.  
  40. Every time compressed text is displayed, it is decompressed on the fly. If it is not altered, it does not need to be recompressed. However, if it is altered, it will be recompressed and stored back in its file.
  41.  
  42. Because of this, it may be prudent to work with a document as uncompressed text, and before distribution, manually recompress it. This way you will avoid the decompression/recompression cycle every time you edit text.
  43.  
  44. ---------
  45. SEARCHING
  46. ---------
  47.  
  48. SmartDoc allows two types of text searching: Through the Find menu in the List view and through the Global Find (silk-screened Find button).
  49.  
  50. The Find menu only searches through the current (open) document, searching sequentially through the text.
  51.  
  52. The Global Find searches sequentially through all documents. This could take a long time if you have many or long documents. This may be enabled or disabled through the Preferences dialog.
  53.  
  54. If Global Find is disabled, you may enable individual documents to be searched with Global Find (Overide Global Find). This is done through the Info dialog or through the Global icon in the List view. This allows you to search through only documents that you wish to search through, skipping others that don't need to be searched.
  55.  
  56. -------------
  57. AUTOSCROLLING
  58. -------------
  59.  
  60. You can have SmartDoc automatically scroll the document for handless reading or for basic teleprompting-type use.
  61.  
  62. Tap on the triangle that represents the "Play" button and SmartDoc will begin scrolling.
  63.  
  64. Tap on the square that appears to stop scrolling.
  65.  
  66. Use the MemoPad and ToDo buttons to increase and decrease the scrolling speed respectively.
  67.  
  68. Press the Addresses button to pause the scrolling. Press it again to unpause.
  69.  
  70. Press the Dates button to stop scrolling.
  71.  
  72. When SmartDoc reaches the end of the document, the scrolling will automatically stop.
  73.  
  74. NOTE: While SmartDoc is scrolling or paused, your device will not go into sleep mode. Be aware not to leave SmartDoc scrolling or paused if you do not intend to do so, otherwise you may unintentionally use up battery power. As soon as you stop the scrolling or close the document, your device will sleep according to the system settings.
  75.  
  76. --------------------------
  77. SYSTEM TEXT EDIT FUNCTIONS
  78. --------------------------
  79.  
  80. SmartDoc allows you to use the System text editing functions such as copy, paste, and undo. However, the system imposes limit to the amount of text that may be put on the clipboard. Since Doc format documents may be much larger than the working memory in your device, Select All has been changed to Select Block while working in the Document view. A block may be as large as 8k of text.
  81.  
  82. --------
  83. NetMarks
  84. --------
  85.  
  86. NetMarks are essentially bookmarks for Uniform Resource Locators (URLs). Each NetMark consists of a name for the NetMark and an associated URL. These may be saved into a list. Later versions of SmartDoc will have more NetMark management capabilities.
  87.  
  88. ------------
  89. Installation
  90. ------------
  91.  
  92. Install the SmartDoc.prc as you would with other software by using the installation software that accompanied your device. The SmartDoc icon will appear when you tap the Application icon.
  93.  
  94. ------------
  95. Registration
  96. ------------
  97.  
  98. SmartDoc can be purchased from Cutting Edge Software, Inc. at 800-991-7360 (US), 972-473-8710 (Intl) or on the web at http://www.cesinc.com
  99.  
  100. -------
  101. Contact
  102. -------
  103.  
  104. Visit our web site at: http://www.cesinc.com
  105.  
  106. Email us at: sales@cesinc.com
  107.  
  108. ====================
  109. ELEMENTS OF SMARTDOC
  110. ====================
  111.  
  112. Below is a description of all the elements available in SmartDoc.
  113.  
  114. ---------
  115. LIST VIEW
  116. ---------
  117.  
  118. This view shows the list of documents that are present on your device.
  119.  
  120.  
  121. ICONS
  122.  
  123. ----ACTION- This icon allows actions to be performed on the document. Tap on the icon to popup a list of actions.
  124.  
  125. ----BACKUP- This icon indicates whether the document will be backed up on the HotSync. Tap on it to toggle the setting.
  126.  
  127. ----GLOBAL FIND- This icon indicates whether the document will be searched with a Global Find regardless of whether the Globaal Find preference is set. This means that if Global Find in Preferences is off, the document will still be searched.
  128.  
  129. ----PRIVATE- This icon indicates whether the document is a private document. Of course, if private documents are set to be hiidden in the System Security preferences, the document will not appear in the list.
  130.  
  131.  
  132. ACTION ICON- Tap the icon to popup the Action menu.
  133.  
  134. ----OPEN AS COPY- Select this to duplicate the document and open it.
  135.  
  136. ----INFO- Open the Info dialog for the document.
  137.  
  138. ----CHANGE CATEGORY- Select this to change the category of the document. The Category popup in the upper right corner will poopup. Select a category to assign to the document.
  139.  
  140. ----APPEND MEMO- Select this to append a memo the the document. A memo selection dialog will appear. Tap the title of a memo  to select it.
  141.  
  142. ----COMPRESSION- Select this to toggle the compression status of the document. If it is compressed already, it will be uncomppressed, and vice versa. See Compression.
  143.  
  144. ----DUPLICATE- Select this to duplicate the document.
  145.  
  146. ----PRINT- Select this to print the document. (Requires third party software.)
  147.  
  148. ----BEAM- Select this to beam the document.
  149.  
  150. ----DELETE- Select this to delete the document.
  151.  
  152.  
  153. NEW BUTTON- Tap this to create a new blank document.
  154.  
  155.  
  156. CATEGORY POPUP- This indicates which category to display in the List view. Tap it to popup a list of categories. Tap on one to select a category.
  157.  
  158.  
  159. DOC MENU
  160.  
  161. ----NEW- Select this to create a new blank document. The document will be compressed or uncompressed according to the prefereence selected in Preferences. 
  162.  
  163. ----SET ALL DOCS TO BACKUP- Select this to set all documents to be backed up on the next HotSync.
  164.  
  165. ----SET NO DOCS TO BACKUP- Select this to set no documents to be backed up on the next HotSync.
  166.  
  167. ----BEAM ALL IN CATEGORY- Select this to beam all the documents in the current category.
  168.  
  169. ----DOWNLOAD- Select this to open up the Get File dialog.
  170.  
  171. ----DELETE ALL IN CATEGORY- Select this to delete all the documents in the current category.
  172.  
  173.  
  174. VIEW MENU
  175.  
  176. ----BY NAME- Select this to display documents in alphabetical order.
  177.  
  178. ----BY SIZE- Select this to display documents in order of increasing size.
  179.  
  180. ----BY DATE CREATED- Select this to display documents in order of the creation date.
  181.  
  182. ----BY DATE LAST TOUCHED- Select this to display documents in the order of last used.
  183.  
  184. ----OPTIONS- Select this to open up the View Options dialog.
  185.  
  186.  
  187. OPTIONS MENU
  188.  
  189. ----ABOUT- Select this to open up the About dialog.
  190.  
  191. ----BEAM SMARTDOC- Select this to beam the SmartDoc application to another device.
  192.  
  193. ----VALIDATE CODE- Select this to open up the Validate Code dialog.
  194.  
  195. ----PREFERENCES- Select this to open up the Preferences dialog.
  196.  
  197.  
  198. DATE- This indicates the date of the document. Its settings are controlled in the View Options dialog.
  199.  
  200.  
  201. SIZE- This indicates the size of the document. If the typeface is in bold lettering, the document is uncompressed. If the typeface is in regular lettering, the document is compressed.
  202.  
  203. -------------
  204. DOCUMENT VIEW
  205. -------------
  206.  
  207. This view allows you to read and edit the document.
  208.  
  209. EDITABLE/READ ONLY SWITCH- This indicates whether the document is editable. Tap it to toggle from Read Only to Editable and vice versa.
  210.  
  211. CATEGORY POPUP- This indicates the category that is assigned to the document. Tap it to popup a list of categories. Tap on one to select a category.
  212.  
  213. DONE BUTTON- Tap this to close the current document and return to the List view.
  214.  
  215. INFO BUTTON- Tap this to open up the Info dialog.
  216.  
  217. F BUTTON- Tap this to open up the Find dialog.
  218.  
  219. PLAY BUTTON- Tap this to begin autoscrolling. Tap it again to stop autoscrolling.
  220.  
  221. FONT BUTTONS- Tap on one of these to change the display font of the text.
  222.  
  223.  
  224. BOOKMARK POPUP- Tap this to popup a list of bookmarks for the document. Select a name to go to the position of the bookmark in the document.
  225.  
  226. ----ADD BOOKMARK- Select this to bookmark the current position. The first 15 characters that appear at the top of the documennt will appear as the bookmark name.
  227.  
  228. ----EDIT BOOKMARKS- Select this to open the Edit Bookmarks dialog.
  229.  
  230. DOC MENU
  231.  
  232. ----NEW- Select this to close the current document and create a new blank document.
  233.  
  234. ----CLOSE- Select this to close the current document and return to the List view.
  235.  
  236. ----INFO- Select this to open the Info dialog.
  237.  
  238. ----RENAME- Select this to open the Info dialog. There you may rename the document.
  239.  
  240. ----COMPRESSION- Select this to toggle the compression status of the document. If it is compressed already, it will be uncomppressed, and vice versa.
  241.  
  242. ----DUPLICATE- Select this to duplicate the document. The original document will be closed and the copy will be opened.
  243.  
  244. ----PREPARE FOR DISTRIBUTION- Select this to open the Prepare for Distribution dialog.
  245.  
  246. ----UPLOAD BY FTP- Select this to open the Upload dialog.
  247.  
  248. ----PRINT- Select this to print the document. (Requires third party software.)
  249.  
  250. ----BEAM- Select this to beam the document.
  251.  
  252. ----DELETE- Select this to delete the document.
  253.  
  254.  
  255. NAVIGATE MENU
  256.  
  257. ----ADD BOOKMARK- Select this to bookmark the current position.
  258.  
  259. ----EDIT BOOKMARKS- Select this to open the Edit Bookmarks dialog.
  260.  
  261. ----SCAN EMBEDDED BOOKMARKS- Select this to scan the current document for embedded (bracketed) bookmarks.
  262.  
  263. ----SCAN CUSTOM BOOKMARKS- Select this to open the Scan Custom Bookmarks dialog.
  264.  
  265. ----DELETE ALL BOOKMARKS- Select this to delete all bookmarks.
  266.  
  267. ----FIND- Select this to open the Find and Replace dialog. This is different than Global Find.
  268.  
  269. ----FIND NEXT- Select this to find the next instance of the last Find text.
  270.  
  271. ----REPLACE- Select this to replace with or insert the last Replace text.
  272.  
  273. ----GO TO TOP- Select this to go to the top of the document.
  274.  
  275. ----GO TO BOTTOM- Select this to go to the bottom of the document.
  276.  
  277.  
  278. SCREEN- Tap the screen to scroll the text. If you tap the top of the screen, the text scrolls up. If you tap the bottom of the screen, the text scrolls down. You may hold the stylus down for continuous scrolling. With continuous scrolling, the middle of the screen allows scrolling to pause.
  279.  
  280. ------------
  281. VIEW OPTIONS
  282. ------------
  283.  
  284. SHOW SIZES- Check this to display sizes for each document in the List view. Uncheck to not display.
  285.  
  286. SHOW BYTES- Check this to display sizes in bytes. Uncheck this to display sizes in kilobytes (k).
  287.  
  288. SHOW DATES- Check this to display dates for each document in the List view. Uncheck to not display.
  289.  
  290. CREATED/LAST- Select a display type for the dates. Select Created for creation date. Select Last for last date used.
  291.  
  292.  
  293. ICONS
  294.  
  295. ----SHOW ACTION- Check this to display the Action icon. This allows actions to be performed on the document.
  296. ----
  297. ----SHOW BACKUP- Check this to display the Backup icon. This indicates whether the document will be backed up on the next HotSSync.
  298. ----
  299. ----SHOW GLOBAL- Check this to display the Global Find icon. This indicates whether the document will be searched by Global Fiind regardless of the Global Find setting in Preferences.
  300. ----
  301. ----SHOW PRIVATE- Check this to display the Private icon. This indicates whether the document is set as a private.
  302.  
  303. -----------
  304. PREFERENCES
  305. -----------
  306.  
  307. SCROLL/TAPS
  308.  
  309. PAGE/LINE- Select whether to scroll by page or single line.
  310.  
  311. OVERLAP LINE- Check this to have an overlapping line when scrolling by page.
  312.  
  313. DOWN ONLY- Check this to have the screen scroll down only when tapped.
  314.  
  315. LEFT HANDED- Check this to have scroll bars appear on the left side.
  316.  
  317.  
  318. TEXT
  319.  
  320. ----LEFT/RIGHT- Select whether to left or right justify the text.
  321.  
  322. ----LINED TEXT- Check this to have lined text.
  323. ----
  324. START NEW DOCS COMPRESSED- Check this to have new documents created as compressed. Uncheck this to have new documents created as uncompressed.
  325.  
  326. AUTOSCAN EMBEDDED BOOKMARKS- Check this to have uninitialized documents automatically scanned for embedded (bracketed) bookmarks.
  327.  
  328. ALLOW GLOBAL FIND- Check this to enable Global Find for SmartDoc. Uncheck to disable Global Find for SmartDoc.
  329.  
  330. ------------------------
  331. PREPARE FOR DISTRIBUTION
  332. ------------------------
  333.  
  334. GO TO TOP OF DOCUMENT- Check this if you wish to reset the document to the top.
  335.  
  336. BACKUP ON HOTSYNC- Check this if you wish to have the document backed up on the next HotSync.
  337.  
  338. UNDO PRIVATE (IF SET)- Check this if you wish to undo the Private setting for the document.
  339.  
  340. UNDO OVERIDE GLOBAL FIND (IF SET)- Check this if you wish to undo the Overide Global Find setting for the document.
  341.  
  342. SET CATEGORY TO UNFILED- Check this if you wish to set the document to the Unfiled category.
  343.  
  344. COMPRESS (IF NOT COMPRESSED)- Check this if you wish to compress the document. Compression may take a long time to perform. See Compression.
  345.  
  346. DEFAULT BUTTON- Tap this to set all the check boxes to the recommended actions.
  347.  
  348. OK BUTTON- Tap this to perform the chosen actions.
  349.  
  350. --------------
  351. EDIT BOOKMARKS
  352. --------------
  353.  
  354. BOOKMARK LIST- The list of bookmarks available for the current document will appear. To select a bookmark, tap on it and a flashing insertion point will appear. You may then edit the name of the bookmark. You may also change the order of a bookmark by dragging and dropping to another location on the list.
  355.  
  356. GO BUTTON- Tap this to go to the selected bookmark. If none is selected, this will do nothing.
  357.  
  358. DELETE BUTTON- Tap this to delete the selected bookmark. If none is selected, this will do nothing.
  359.  
  360. DELETE ALL BUTTON- Tap this to delete all bookmarks in the list.
  361.  
  362. SCAN EMBEDDED BUTTON- Tap this to scan the current document for embedded (bracketed) bookmarks.
  363.  
  364. SCAN CUSTOM BUTTON- Tap this to open the Scan Custom Bookmarks dialog.
  365.  
  366. SORT ALPHABET BUTTON- Tap this to sort the bookmarks in alphabetical order.
  367.  
  368. SORT APPEAR BUTTON- Tap this to sort the bookmarks in order of appearance in the document.
  369. ----
  370. ---------------------
  371. SCAN CUSTOM BOOKMARKS
  372. ---------------------
  373.  
  374. SEARCH FOR FIELD- Enter the text for the bookmark search.
  375.  
  376. ONLY AT BEGINNING OF LINE CHECK BOX- Check this if the text should only be found at the beginning of a line of text.
  377.  
  378.  
  379. BOOKMARK NAMES
  380.  
  381. ----NAME CHECK BOX- Check this if every bookmark has the same name. "Chapter" would be a good example.
  382.  
  383. ----NAME FIELD- Enter the name of the bookmark. "Chapter" would be a good example.
  384.  
  385. ----ADD COUNT CHECK BOX- Check this if you wish to automatically number the bookmarks.
  386.  
  387. ----NUMBER OF CHARACTERS CHECK BOX- Check this if you wish to include the text after the search text to be used in the bookmaark name.
  388.  
  389. ----NUMBER OF CHARACTERS FIELD- Enter the number of characters to include. There is a limit of 15 characters.
  390.  
  391. ----------------
  392. FIND AND REPLACE
  393. ----------------
  394.  
  395. TEXT TO LOOK FOR- Enter the text to search.
  396.  
  397. TEXT TO REPLACE WITH- Enter the text to replace with.
  398.  
  399. FIND BUTTON- Tap this to find the next instance of the search text.
  400.  
  401. REPLACE BUTTON- Tap this to replace the selected text with the replacement text.
  402.  
  403. R/F BUTTON- Tap this to replace the selected text with the replacement text and find the next instance of the search text.
  404.  
  405. --------
  406. GET FILE
  407. --------
  408.  
  409. NETMARK NAME FIELD- Enter the name of the NetMark. A description of the URL would be appropriate.
  410.  
  411. USER NETMARKS POPUP- Tap this to popup a list of NetMarks that may be maintained by you.
  412.  
  413. URL FIELD- Enter the URL to get.
  414.  
  415. TEXT BUTTONS- Tap one of these buttons to insert/replace the corresponding text into the URL.
  416.  
  417. HISTORY POPUP- Tap this to popup a list of previously used NetMarks. Select one to use it.
  418.  
  419. USER FIELD- Enter the user name if accessing an FTP site. You may leave it blank if you are using an anonymous FTP site.
  420.  
  421. PASS FIELD- Enter the password if accessing an FTP site. You may leave it blank if you are using an anonymous FTP site.
  422.  
  423. ADD BUTTON- Tap this to add the current NetMark to the User NetMarks list.
  424.  
  425. CLEAR BUTTON- Tap this to clear the User NetMarks list.
  426.  
  427. GET BUTTON- Tap this to retrieve the URL from the Internet. Your device must be set up properly to access the Internet. See the users manual that came with your device for more details.
  428.  
  429. -----------
  430. UPLOAD FILE
  431. -----------
  432.  
  433. NETMARK NAME FIELD- Enter the name of the NetMark. A description of the URL would be appropriate.
  434.  
  435. URL FIELD- Enter the URL to get.
  436.  
  437. TEXT BUTTONS- Tap one of these buttons to insert/replace the corresponding text into the URL.
  438.  
  439. HISTORY POPUP- Tap this to popup a list of previously used NetMarks. Select one to use it.
  440.  
  441. USER FIELD- Enter the user name if accessing an FTP site. You may leave it blank if you are using an anonymous FTP site.
  442.  
  443. PASS FIELD- Enter the password if accessing an FTP site. You may leave it blank if you are using an anonymous FTP site.
  444.  
  445. SAVE AS TEXT FILE CHECK BOX- Check this if you are sending the file as a text file. Leave it unchecked if you are sending the file as a Palm database (pdb file).
  446.  
  447. PUT BUTTON- Tap this to send the document to the URL on the Internet. Your device must be set up properly to access the Internet. See the users manual that came with your device for more details.
  448.  
  449. ----
  450. INFO
  451. ----
  452.  
  453. TITLE FIELD- This displays the title of the document. If you wish to change it, edit the text.
  454.  
  455. CATEGORY POPUP- This indicates the category that is assigned to the document. Tap it to popup a list of categories. Tap on one to select a category.
  456.  
  457. SIZE- This indicates the size of the document in bytes. This disregards any overhead for the database.
  458.  
  459. COMPRESSION STATUS- This indicates the compression status of the document.
  460.  
  461. PRIVATE CHECK BOX- Check this if you wish the document to be private. Uncheck it if you don't. Private documents will not be searched with Global Find. Remember that Private documents are not "secure" documents.
  462.  
  463. BACKUP CHECK BOX- Check this if you wish the document to be backed up on the next HotSync. Uncheck it if you don't.
  464.  
  465. OVERIDE GLOBAL FIND CHECK BOX- Check this if you wish to have the document searched by Global Find regardless of the Global Find setting in Preferences.
  466.  
  467. DELETE BUTTON- Tap this to delete the document.
  468.  
  469. -------------
  470. VALIDATE CODE
  471. -------------
  472.  
  473. REGCODE FIELD- This displays the RegCode of your device. It is based on your HotSync ID.
  474.  
  475. NAME- Enter your name here.
  476.  
  477. ORGANIZATION- Enter the name of your organization here.
  478.  
  479. VALIDATION CODE- Enter the validation code that you received after purchasing SmartDoc.
  480.  
  481. OK- Tap this to validate.
  482.  
  483. ---------
  484. EDIT MENU
  485. ---------
  486.  
  487. UNDO- Select this to undo the last Edit menu function.
  488.  
  489. CUT- Select this to cut the selected text.
  490.  
  491. COPY- Select this to copy the selected text.
  492.  
  493. PASTE- Select this to paste previously cut or copied text.
  494.  
  495. SELECT ALL- Select this to select all the text.
  496.  
  497. SELECT BLOCK- Select this to select a block of text. Since only a portion of a document is used/visible at a time, only a block will be selected.
  498.  
  499. KEYBOARD- Select this to bring up the System keyboard.
  500.  
  501. GRAFFITI- Select this to bring up the Graffiti help.
  502.  
  503. =======
  504. LICENSE
  505. =======
  506.  
  507. This software is licensed to you under the terms of the Cutting Edge Software, Inc. Software License Agreement.  You should have received a copy of this agreement with your software distribution.  If not, you can request a copy from us by calling our sales dept. at 972-473-8710.
  508.  
  509. -------
  510. Credits
  511. -------
  512.  
  513. Palm Computing, HotSync, and Graffiti are registered trademarks and Palm is a trademark of Palm Computing, Inc., 3Com Corporation or its subsidiaries.
  514.  
  515. Doc is a trademark of Aportis Technologies Corp. and Rick Bram.
  516.  
  517. RegCode code is based on PalmCreation's description of RegCode appearance.
  518.  
  519. Portions adapted from UnixDoc.cpp (freeware) by Pat Beirne.  For further information on UnixDoc, see http://24.112.88.27/ and http://24.112.88.27/makedoc9.cpp.
  520.  
  521. SmartDoc and NetMarks are Copyright ©1998 Yischon Liaw, MD. All Rights reserved.
  522.  
  523. http://www.cesinc.com
  524. sales@cesinc.com